home *** CD-ROM | disk | FTP | other *** search
/ Hardcore Gamer Resource Kit / Hardcore Gamer Resource Kit - Disc 2.iso / Pc / GRAVIS / ULTWLF13.ZIP / ULTRAWLF / ULTRAWLF.DOC < prev    next >
Text File  |  1993-11-06  |  14KB  |  365 lines
  1.  
  2.  
  3. -= ACHTUNG! =-
  4.  
  5.      It's..
  6.  
  7.  
  8.  
  9.       ..Lazy Jones'
  10.  
  11.  
  12.       U   U   L       TTTTT   RRRR     AAA    W   W    OOO    L       FFFFF
  13.       U   U   L         T     R   R   A   A   W   W   O   O   L       F
  14.       U   U   L         T     R   R   A   A   W   W   O   O   L       F
  15.       U   U   L         T     RRRR    AAAAA   W   W   O   O   L       FFF
  16.       U   U   L         T     R R     A   A   W W W   O   O   L       F
  17.       U   U   L         T     R  R    A   A   WW WW   O   O   L       F
  18.        UUU    LLLLL     T     R   R   A   A   W   W    OOO    LLLLL   F
  19.  
  20.  
  21.                -= Gravis Ultrasound Support for Wolfenstein3D =-
  22.  
  23.                 - Version 1.31 -
  24.  
  25.  
  26.  
  27. Note for Distributors
  28. ---------------------
  29.  
  30. UltraWolf may be freely distributed (PD). It may and shall be copied via
  31. bulletin board systems, diskettes or other media without any restrictions.
  32. In other words:
  33.  
  34.                            SPREAD IT or LEAVE IT :)
  35.  
  36.  
  37.  
  38. READ THIS MANUAL FIRST!
  39. -----------------------
  40.  
  41. If you have any devices that may conflict with the standard Ultrasound
  42. settings then read the manual completely! I will not feel responsible for any
  43. data loss you may encounter due to the use of this program!
  44.  
  45.  
  46.  
  47. What is UltraWolf?
  48. ------------------
  49.  
  50. If you like Wolfenstein3D and are not too impressed by that (IMHO f*cking)
  51. SB, SBPro, SBPro++, SBPro16² (ahem) and compatible cards, you will (hopefully)
  52. love the UltraWolf package: It will redirect Wolfenstein's digital audio
  53. output (say: samples) to your Ultrasound card. (Sounds not too exciting, eh?
  54. But there's more: ) Using the UltraWolf software, you will be able to hear up
  55. to 14 screams, eh, samples ;) at the same time. That means, you will no longer
  56. be forced to release the trigger when shooting that bad guy >:-> You will also
  57. be able to make out the distance and location of your enemies. Furthermore,
  58. you can modify any of the samples to your like. And as if that is not enough,
  59. you can listen to your favourite mods during gameplay. UltraWolf uses your
  60. Ultrasound card's capabilities directly, that means you won't need SBOS or
  61. similar drivers.
  62.  
  63.  
  64.  
  65. Memory requirements
  66. -------------------
  67. So far, UltraWolf needs about 80k of memory (16k program, 64k songbuffer).
  68. The songbuffer will not be allocated when disabling the modplayer (opt /DM).
  69.  
  70.  
  71.  
  72. Installing UltraWolf
  73. --------------------
  74.  
  75. First of all you should enter Wolfenstein and disable all sound output in
  76. the options menu. I don't know if this is necessary but you may encounter
  77. problems if you have any other soundcard besides the Ultrasound installed.
  78. Copy all UltraWolf files to your Wolfenstein directory or create a new dir
  79. where you put all UltraWolf files (see 'commandline parameters'). The files
  80. UWINS1.EXE and UWINS16.EXE should reside in your Wolfenstein3D directory
  81. (they can be deleted later on). I also suggest that you put ULTRAWLF.EXE in
  82. your Wolf3D directory. Make a backup of your WOLF.EXE or WOLF3D.EXE files
  83. since once they have been patched they will only run in conjunction with
  84. UltraWolf. If you have the shareware game then run UWINS1.EXE (you may have
  85. to rename WOLF3D.EXE to WOLF.EXE first), if you have the commercial version
  86. 1.1 (hope you paid for your copy) run UWINS16.EXE.
  87.  
  88. UWINS will patch the WOLF (shareware) or WOLF3D (commercial) executables to
  89. make them work with the UltraWolf device. I have tested UltraWolf with the
  90. shareware version 1.0 and the commercial version 1.1 (parts 1-6), and it's
  91. highly unlikely that UltraWolf will run with other versions. If your version
  92. is not compatible with UltraWolf try to get the shareware version 1.0.
  93.  
  94. Once UWINS has patched your Wolfenstein copy you may delete the UWINS*.EXE
  95. files. From now on, every time you want to play Wolfenstein3D you'll have to
  96. install the memory resident UltraWolf driver first. The batchfile GO.BAT will
  97. do that for you but you may have to modify it first. UltraWolf will not check
  98. the DOS environment variables so if you don't want UltraWolf to use the
  99. standard Irq (11) you must tell UltraWolf which interrupt to use. In addition,
  100. you may have to tell UltraWolf where to search for the sound files.
  101.  
  102. If all UltraWolf files reside in your Wolfenstein3D directory and your
  103. Ultrasound card configuration is standard you may run GO.BAT now. If not,
  104. read on and change the batchfile to suit your needs.
  105.  
  106.  
  107.  
  108. Commandline parameters
  109. ----------------------
  110.  
  111. There are a few options you can give UltraWolf on the way:
  112.  
  113. /Bn    -> n indicates the baseportaddress of your Ultrasound card. You can
  114.        use this option if your computer locks up when executing UltraWolf.
  115.        Valid values for n are: 210, 220, 230, 240, 250, 260.
  116.  
  117. /In    -> n indicates the Ultrasound interrupt you want UltraWolf to use.
  118.        The default IRQ is 11.
  119.        Valid values for n are: 2, 3, 5, 7, 11, 12, 15.
  120.  
  121. /DS    -> disable sound fx. This way you get a chance of checking out the
  122.            modplayer even if your card has only the standard amount of 256K
  123.            onboard memory.
  124.  
  125. /DM    -> disable modplayer.
  126.  
  127. PATH    -> a commandline parameter not beginning with '/' will be interpreted
  128.        as a path to an UltraWolf directory. UltraWolf will search all the
  129.        needed files in the indicated directory instead of the current
  130.        directory.
  131.  
  132. Calling ULTRAWLF when installed already will remove it from memory.
  133.  
  134.  
  135.  
  136. Modifying samples
  137. -----------------
  138.  
  139. Included with this package are a number of files which end with .SND. These
  140. are (did you think?) the samples that are cached to the GUS-DRAM by UltraWolf
  141. The samples have been ripped from the VSWAP.WL? data file and, to make them
  142. fit into 256K, some of them have been slightly modified (I haven't figured out
  143. yet how to rip them automatically). If your card's onboard memory has been
  144. extended you may use larger samples, of course. To use your own samples simply
  145. copy them over the corresponding WOLF??.SND files (see below) and change the
  146. frequency and basevolume for these samples in the UWOLFSMP.INF file.
  147.  
  148. The UWOLFSMP.INF file may look like this:
  149.  
  150. ------------------------------------ BoF --------------------------------------
  151. 8000, 65535        ; WOLF00.SND - 'halt stop'
  152. 8000, 65535        ; WOLF01.SND - 'achtung'
  153. 4000, 30000        ; WOLF02.SND - 'swinehunt'
  154. ...
  155. 8000, 20000        ; WOLF2D.SND - 'mein leben!'
  156. ------------------------------------ EoF --------------------------------------
  157.  
  158.  
  159. Explanation:
  160.  
  161.  
  162. 8000, 65535        ; WOLF2D.SND - 'mein leben!'
  163.  
  164. ^     ^            ^
  165. |     |            |
  166. |     |            +--- this character indicates that a comment is
  167. |     |                 following (optional)
  168. |     |
  169. |     +--------------------- (decimal) basevolume for the sample. The sample
  170. |                 will be played with this volume when the player's
  171. |                 location is equal to the sound source.
  172. |
  173. +--------------------------- (decimal) sample frequency
  174.  
  175.  
  176. The infofile must contain 46 entries like the above.
  177.  
  178. If you i.e. wanted to change the third sample you would have to copy your
  179. sample over WOLF02.SND (counting from 00) and then change the parameters in
  180. the third line of the info file. Note that if you wanted to change the 11th
  181. sample you would have to overwrite WOLF0A.SND, not WOLF10.SND, but you already
  182. knew that, right? BTW: There may be no empty lines or pure comment lines in
  183. the info file.
  184.  
  185. Note: The samples are stored as raw unsigned 8-bit data. You can directly use
  186. samples you recorded with USS8.
  187.  
  188.  
  189.  
  190. How to install your personal combat tunes
  191. -----------------------------------------
  192.  
  193. If you have extended your GUS' onboard memory to at least 512KB then you can
  194. listen to your favourite MODs during gameplay. Just like the UWOLFSMP.INF
  195. infofile you can easily manipulate the UWOLFMOD.INF info file.
  196.  
  197. The UWOLFMOD.INF file may look like this:
  198.  
  199. ------------------------------------ BoF --------------------------------------
  200. nowwhat3.mod,    40,     3,12,12, 3, 7, 7, 7, 7        ; Levels 1.1 & 4.1
  201. covergir.mod,    30,     3,12,12, 3, 7, 7, 7, 7        ; Hiscore
  202. ...
  203. ------------------------------------ EoF --------------------------------------
  204.  
  205.  
  206. Explanation:
  207.  
  208. nowwhat3.mod,    40,     3,12,12, 3, 7, 7, 7, 7        ; levels 1.1 & 4.1
  209.  
  210. ^         ^     ^  ^  ^  ^  ^  ^  ^  ^     ^
  211. |         |     |  |  |  |  |    |  |  |        |
  212. |         |     |  |  |  |  |    |  |  |         +- comment following
  213. |         |     |  |  |  |  |    |  |  |           (optional)
  214. |         |     |  |  |  |  |    |  |  |
  215. |         |     +--+--+--+--+--+--+--+----------- (decimal) pan
  216. |         |                          positions for
  217. |         |                       channels 1 to 8
  218. |         |
  219. |         +---------------------------------------- (decimal) song's
  220. |                               mastervolume
  221. |                               percentage
  222. |
  223. +--------------------------------------------------------- filename of your
  224.                                favourite MOD
  225.  
  226.  
  227. The infofile must contain 28 lines like the above describing 28 different (or
  228. not) songs. So far as I know only 25 or 26 of them will be played, but I'm not
  229. sure about this.
  230.  
  231. The modplayer is not perfect but supports most of the commonly used Protracker
  232. functions and 4-8 channels mods (M.K., FLT4, ?FLT8, 6CHN, ?8CHN, ?M!K!). It's
  233. also able to play UltraTracker(1.3) songs (limits: 64k songsize; 8 bit samples
  234. only; up to 10 channels).
  235.  
  236. (? = not tested)
  237.  
  238. Unimplemented functions so far:
  239.  
  240. - All functions that affect the finetuning of samples are ignored.
  241. - Inverted loop
  242. - samples > 64K
  243. - all UltraTracker-specific commands except balance sweeping
  244.  
  245. However, the player does quite well with the all mods I've tested it with
  246. (now what 3, space debris, human target, umgah, comandr, bloood ...), although
  247. vibrato & tremolo sound a bit distorted... underworld sounds a bit funny, too.
  248.  
  249.  
  250.  
  251. Aaaarrrggh... that shitty little program doesn't work!
  252. ------------------------------------------------------
  253.  
  254. Q:    When I run Wolfenstein3D there's only silence.
  255. A:    - Have you patched the WOLF/WOLF3D executables? (Silly question but
  256.       there are people who don't RTFM...). If not do it now.
  257.     - Your copy of Wolfenstein3D may not be compatible. Better don't run
  258.       the patched game anymore, strange things may happen. Try to get the
  259.       shareware version 1.0 for now. Future versions of UltraWolf (if any)
  260.       may support your version of Wolfenstein.
  261.     - It may be due to a bug (see below). Simply uninstall UltraWolf and
  262.       run it again.
  263.  
  264. Q:    When I run Wolfenstein3D I hear only noise.
  265. A:    - If you have loaded SBOS, MEGAEM or any other resident programs that
  266.       deal with the Ultrasound card -> throw them out!
  267.  
  268. Q:    Wolfenstein locks up as soon as it's started.
  269. A:    - Try using the command line parameters for setting the Ultrasound
  270.       baseport and irq. UltraWolf won't check the DOS environment vars.
  271.     - If that fails, your copy of Wolfenstein3D may not be compatible with
  272.       UltraWolf. Again, try to get the shareware version 1.0.
  273.     - If you have the shareware version 1.0 then maybe someone has tampered
  274.       with it. Try to get a clean copy without trainer and such stuff.
  275.  
  276. Q:    My Ultrasound card has more than 256K of onboard memory but none of
  277.     the mods will be played.
  278. A:    - Check the path you've started UltraWolf with. If you i.e. started
  279.       UltraWolf in it's own directory without a pathstatement and then
  280.       switched to the Wolf3D directory, UltraWolf won't be able to locate
  281.       the mods you're refering to. Specify a full path to your UltraWolf
  282.       directory in that case.
  283.     - If also no sound effects are played it may be due to a bug (see
  284.       below). Simply uninstall UltraWolf and run it again.
  285.  
  286. Q:    A particular mod won't be played.
  287. A:    - Check the UWOLFMOD.INF infofile for spelling of filenames. The
  288.       suffix (.MOD or whatsoever) must be appended to the filename.    The
  289.       filename may not consist of a path plus a filename. Also check the
  290.       mastervolume setings.
  291.     - The modfile is not one UltraWolf recognizes. Try any other.
  292.  
  293.  
  294.  
  295. Known bugs
  296. ----------
  297.  
  298. - Some samples (attacking dogs, elevator) will not be played in the shareware
  299.   version.
  300. - not yet clickfree (SHAME!²) but I'm working on it.
  301.  
  302.  
  303.  
  304. Fixed bugs
  305. ----------
  306.  
  307. Version 1.2
  308. - version 1.1 enabled irq11 whenever the sampleupdateroutine was called. This
  309.   may have caused trouble on some machines.
  310. - haven't had the 'silence'-bug for a long time now. It seems the irq-handler
  311.   is now initialized correctly.
  312. - removed some clicks (Underworld sounds a bit better now...)
  313. - tremolo & vibrato fixed (hope so)
  314. - arpeggio fixed (subtracted halfnotes ;)
  315. - delay_note & retrig_note fixed (missed 1 VB)
  316.  
  317. Version 1.3
  318. - volslide fixed (A11 slides up now)
  319. - set_sampleoffset fixed (didn't check boundaries)
  320.  
  321. Version 1.31
  322. - fixed nasty nasty nasty bug... UltraWolf hanged when entering levels 2 or 6.
  323.   should work now.
  324.  
  325.  
  326.  
  327. Extensions
  328. ---------
  329.  
  330. Version 1.2
  331. - implemented the set_bpm command
  332. - accepts UltraTracker modules now
  333. - effect E8x (0-F) sets the pan position of a voice
  334.  
  335.  
  336.  
  337. What else?
  338. ----------
  339.  
  340. Hope I didn't forget anything. Thanks and greetings go to:
  341.  
  342. - Renaissance for the UltraDox (and great PC demos of course)
  343.  
  344. - Gravis & Forte for creating the best PC-soundcard at a fair price.
  345.   (Got a priceless daughterboard left? ;)
  346.  
  347. - ID & Apogee for the technically best PC-Game I've ever seen (Wolfenstein3D
  348.   was the reason why I bought my 386)
  349.  
  350. - All groups and programmers who support the GUS
  351.  
  352.  
  353.  
  354. Hope you enjoy my little hack. Now go and GET PSYCHED! And watch your back!
  355.  
  356.  
  357.  
  358.                     ----------------
  359.                     Lazy Jones, 1993
  360.                     ----------------
  361.  
  362.                     If you, for any reason want to
  363.                     contact me, leave me a mail:
  364.                     MEDIA-BBS (+49-40-6779553)
  365.